package org.jsola.hr.web;

import io.swagger.annotations.Api;
import io.swagger.annotations.ApiImplicitParam;
import io.swagger.annotations.ApiImplicitParams;
import io.swagger.annotations.ApiOperation;
import org.jsola.core.Page;
import org.jsola.core.Result;
import org.jsola.hr.dto.NewsInfoAddDTO;
import org.jsola.hr.dto.NewsInfoUpdateDTO;
import org.jsola.hr.query.NewsInfoQuery;
import org.jsola.hr.vo.NewsInfoListVO;
import org.jsola.hr.vo.NewsInfoVO;

import java.util.List;

/**
 * 官网信息的内容
 *
 * @author zhr
 */
@Api(tags = "hr-官网信息的内容")
public interface INewsInfoControllerAPI {

    /**
     * 新增官网信息的类型
     * @param newsInfoAddDTO 官网信息的类型新增实体
     * @return 官网信息的类型展示对象
     */
    @ApiOperation(value = "新增官网信息的类型")
    @ApiImplicitParams({
            @ApiImplicitParam(name = "newsInfoAddDTO", dataType = "NewsInfoAddDTO", value = "新增官网信息的类型", paramType = "body")
    })
    Result<NewsInfoVO> save(NewsInfoAddDTO newsInfoAddDTO);


    /**
     * 修改官网信息的类型
     * @param newsInfoUpdateDTO 官网信息的类型
     * @return 更新数量
     */
    @ApiOperation(value = "修改官网信息的类型")
    @ApiImplicitParams({
            @ApiImplicitParam(name = "newsInfoUpdateDTO", dataType = "NewsInfoUpdateDTO", value = "修改官网信息的类型", paramType = "body")
    })
    Result<Integer> update(NewsInfoUpdateDTO newsInfoUpdateDTO);




    /**
     * 删除单个官网信息的类型，彻底删除
     * @param newsInfoId 官网信息的类型id
     * @return 删除数量
     */
    @ApiOperation(value="删除单个官网信息的类型，彻底删除")
    @ApiImplicitParams({
            @ApiImplicitParam(name = "newsInfoId", dataType = "String", value = "官网信息的类型id", paramType = "path")
    })
    Result<Integer> delete(String newsInfoId);


    /**
     * 批量删除官网信息的类型，彻底删除
     * @param newsInfoIds 官网信息的类型id集合
     * @return 删除数量
     */
    @ApiOperation(value = "批量删除官网信息的类型，彻底删除")
    @ApiImplicitParams({
            @ApiImplicitParam(name = "newsInfoIds", dataType = "String[]", value = "官网信息的类型id数组", paramType = "body" ,allowMultiple = true)
    })
    Result<Integer> deleteBatch(String[] newsInfoIds);


    /**
     * 根据官网信息的类型id查询官网信息的类型详情
     * @param newsInfoId 官网信息的类型id
     * @return 官网信息的类型详情
     */
    @ApiOperation(value="根据官网信息的类型id查询官网信息的类型详情")
    @ApiImplicitParams({
            @ApiImplicitParam(name = "newsInfoId", dataType = "String", value = "官网信息的类型id", paramType = "path")
    })
    Result<NewsInfoVO> findById(String newsInfoId);


    /**
     * 查询官网信息的类型
     * @param newsInfoQuery 官网信息的类型查询参数
     * @return page
     */
    @ApiOperation(value="查询官网信息的类型")
    @ApiImplicitParams({
            @ApiImplicitParam(name = "newsInfoQuery", dataType = "NewsInfoQuery", value = "官网信息的类型查询参数", paramType = "query")
    })
    Result<List<NewsInfoListVO>> listAll(NewsInfoQuery newsInfoQuery);


     /**
     * 分页查询官网信息的类型
     * @param newsInfoQuery 官网信息的类型查询参数
     * @return page
     */
    @ApiOperation(value="分页查询官网信息的类型")
    @ApiImplicitParams({
            @ApiImplicitParam(name = "newsInfoQuery", dataType = "NewsInfoQuery", value = "官网信息的类型查询参数", paramType = "query")
    })
    Result<Page<NewsInfoListVO>> page(NewsInfoQuery newsInfoQuery);

    /**
     * 查询某个信息的详细内容
     * @param newsTypeId 官网信息的类型查询参数
     * @return page
     */
    @ApiOperation(value="查询某个信息的详细内容")
    @ApiImplicitParams({
            @ApiImplicitParam(name = "newsTypeId", dataType = "String", value = "官网信息的类型查询参数", paramType = "query")
    })
    Result<NewsInfoListVO> selectNewsInfoByNewsTypeId(String newsTypeId);
}

